/*
 * MIT License
 *
 * Copyright (c) 2023 北京凯特伟业科技有限公司
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.je.bpm.engine.history;

import com.je.bpm.engine.internal.Internal;

import java.util.Date;

/**
 * A single process variable containing the last value when its process instance has finished. It is only available when HISTORY_LEVEL is set >= VARIABLE
 */
@Internal
public interface HistoricVariableInstance extends HistoricData {

    /**
     * The unique DB id
     */
    String getId();

    String getVariableName();

    String getVariableTypeName();

    Object getValue();

    /**
     * The process instance reference.
     */
    String getProcessInstanceId();

    /**
     * @return the task id of the task, in case this variable instance has been set locally on a task. Returns null, if this variable is not related to a task.
     */
    String getTaskId();

    /**
     * Returns the time when the variable was created.
     */
    Date getCreateTime();

    /**
     * Returns the time when the value of the variable was last updated. Note that a {@link HistoricVariableInstance} only contains the latest value of the variable. The actual different value and value
     * changes are recorded in {@link HistoricVariableUpdate} instances, which are captured on {@link HistoryLevel} FULL.
     */
    Date getLastUpdatedTime();

}
